FlowGroup

Manages the workflow group settings, including members, positions, timeout options, and documents.

Properties

Name	Description
TimeoutOptions	Defines the timeout settings for the group.
Caption	The caption dictionary representing localized captions for the flow object.
EnablePushNotification	Gets or sets a value indicating whether push notification is enabled.
EnableOwnRequest	Specifies whether users can approve their own requests within this group.
ShowInFlowHistory	Indicates whether this group should appear in the workflow history.
HideApporoverInHistory	Determines whether the approver's name is hidden in the workflow history.
TimeoutHour	The number of hours before a timeout occurs.
DetailObjects	Detail objects within the workflow group.
GeolocationOptions	Geolocation options for tracking workflow-related activities.
NotificationMessage	Gets the notification message associated with the message.
PositionGroups	Represents the position groups associated with the workflow group.
EventsToCheck	List of event IDs that should be checked for the workflow group.
MailSubject	Gets the mail subject associated with the message.
Positions	Retrieves the positions resolved for the workflow group members.
ConflictStateEventId	Event ID for handling conflict states in the group.
Key	A unique identifier for the workflow step.
AutoOpenApprovalOption	Specifies whether approvals should open automatically upon group interaction.
TimeoutMinute	The number of minutes before a timeout occurs.
Name	Name for the workflow step.
EmptyGroupEventId	Specifies the event ID triggered when the group is empty.
EnableSendMail	Gets or sets a value indicating whether sending mail is enabled.
TableObjects	List of table objects relevant to the workflow group.
Events	Read-only list of events associated with the workflow group.
MailMessage	Gets the mail message associated with the message.
TimeoutDuration	The total timeout duration for the group.
IsCustomMailMessage	Gets or sets a value indicating whether the mail message is custom.
CustomMailMessage	Gets the custom mail message associated with the message.
MessageOptions	Gets or sets the message options.
RequestIsNecessaryIfDocumentChanged	Specifies if a request is required when the document changes.
WorkflowCodeInstance	The workflow code instance associated with the flow object.
Documents	List of documents associated with the workflow group.
CachedDMObjects	The cached document management objects related to the flow object.
WebNotificationOptions	Gets or sets the web notification options.
NotificationCaption	Gets the notification caption associated with the message.
Attachments	Gets the list of attachments associated with the message.
TypeCode	The type code associated with the flow object.
DoNotSendRequestIfProcessed	Indicates whether a request should be avoided if already processed.
CalculateUsingHolidays	Determines whether holiday settings are considered in timeout calculations.
TimeoutDay	The number of days before a timeout occurs.
Users	Retrieves the users resolved for the workflow group members.
CalculateUsingWorkingHours	Indicates whether working hours are considered for timeout calculations.
Members	Holds the configuration for members within the group.
NotificationOptions	Gets or sets the push notification options.

Constructors

Name	Description
FlowGroup(name, workflowData, workflowCodeInstance)	Constructor for the FlowGroup class. Initializes a new instance of the FlowGroup class.
FlowGroup(name,workflowData,workflowCodeInstance)	Initializes a new instance of the FlowGroup class.
FlowGroup(name, workflowData, workflowCodeInstance)	Initializes a new instance of the FlowGroup class.

Methods

Name	Description
SendApprovalWebNotification(userInfo, requestItem)	Sends a web notification for approval to the specified user.
AddDocument(flowDocument, viewName, viewId, panelSize, allowEdit, showEvents)	Adds a document to the workflow group with various display options.
AddConstantUser(id, userName, userCode)	Adds a constant user to the workflow group with additional details.
AddConstantPosition(id)	Adds a constant position to the workflow group using its ID.
IsEmpty()	Checks if the workflow group has no members or positions.
ClearGroup()	Clears all members, positions, and related settings from the workflow group.
SendWebNotification(payloadType,userInfo,requestItem)	Sends a web notification to a user.
AddConstantPosition(id, positionCode, positionDescription)	Adds a constant position to the workflow group with additional details.
AddConstantUser(id)	Adds a constant user to the workflow group using their ID.
GetUserInfo(requestItem)	Retrieves user information for a given process request item.
SendRequestTimedOutWebNotification(userInfo, requestItem)	Sends a real-time notification to the user indicating that the request has timed out, prompting the client to close any related open forms.
SendMail(requestItem, userInfo)	Sends an email to a user associated with the process request.
AddDepartmentBasedUserGroup(departmentId, titleId)	Adds a user group based on department and title to the workflow group.
Initialize()	Initializes the workflow group with default configurations.
RemoveDocument(flowDocument)	Removes a document from the workflow group.
ToLiquid()	Converts the workflow group configuration into a Liquid-compatible format.
AddAttachment(value,type)	Adds an attachment to the mail message.
SendRequestsCanceledWebNotification(userInfo, requestItem)	Sends a real-time notification to the user indicating that the current request has been canceled, prompting the client to close any associated open forms.
SendPushNotification(userInfo,requestItem)	Sends a push notification to a user.

Events

Name	Description
OnAfterExecution(sender, args)	Occurs after the execution of the workflow step.
OnAfterEvent(sender, args)	Occurs after the execution of the workflow step.
OnBeforeEvent(sender, args)	Occurs after the execution of the workflow step.
OnBeforeExecution(sender, args)	Occurs before the execution of the workflow step.